@@ -1,5 +1,11 @@
Revision history for Perl extension Server::Starter.
+0.11
+ - remove unix socket file on shutdown
+
+0.10
+ - support for unix sockets with --path option
+
0.09
- added options: --signal-on-hup, --status-file, --restart
@@ -23,3 +23,5 @@ t/01-starter-echod.pl
t/01-starter.t
t/02-startfail-server.pl
t/02-startfail.t
+t/03-starter-unix-echod.pl
+t/03-starter-unix.t
@@ -1,7 +1,7 @@
---
abstract: 'a superdaemon for hot-deploying server programs'
author:
- - 'Kazuho Oku <kazuhooku@gmail.com>'
+ - 'Kazuho Oku'
build_requires:
ExtUtils::MakeMaker: 6.42
configure_requires:
@@ -25,4 +25,4 @@ requires:
perl: 5.8.0
resources:
license: http://dev.perl.org/licenses/
-version: 0.09
+version: 0.11
@@ -7,6 +7,7 @@ use Carp;
use Fcntl;
use IO::Handle;
use IO::Socket::INET;
+use IO::Socket::UNIX;
use List::MoreUtils qw(uniq);
use POSIX qw(:sys_wait_h);
use Proc::Wait3;
@@ -14,7 +15,7 @@ use Scope::Guard;
use Exporter qw(import);
-our $VERSION = '0.09';
+our $VERSION = '0.11';
our @EXPORT_OK = qw(start_server restart_server server_ports);
my @signals_received;
@@ -31,10 +32,14 @@ sub start_server {
$opts->{signal_on_hup} =~ s/^SIG//i;
# prepare args
- my $ports = $opts->{port}
- or croak "mandatory option ``port'' is missing\n";
+ my $ports = $opts->{port};
+ my $paths = $opts->{path};
+ croak "either of ``port'' or ``path'' option is mandatory\n"
+ unless $ports || $paths;
$ports = [ $ports ]
- unless ref $ports eq 'ARRAY';
+ if ! ref $ports && defined $ports;
+ $paths = [ $paths ]
+ if ! ref $paths && defined $paths;
croak "mandatory option ``exec'' is missing or is not an arrayref\n"
unless $opts->{exec} && ref $opts->{exec} eq 'ARRAY';
@@ -104,6 +109,28 @@ sub start_server {
push @sockenv, "$port=" . $sock->fileno;
push @sock, $sock;
}
+ my $path_remove_guard = Scope::Guard->new(
+ sub {
+ -S $_ and unlink $_
+ for @$paths;
+ },
+ );
+ for my $path (@$paths) {
+ if (-S $path) {
+ warn "removing existing socket file:$path";
+ unlink $path
+ or die "failed to remove existing socket file:$path:$!";
+ }
+ unlink $path;
+ my $sock = IO::Socket::UNIX->new(
+ Listen => Socket::SOMAXCONN(),
+ Local => $path,
+ ) or die "failed to listen to file $path:$!";
+ fcntl($sock, F_SETFD, my $flags = '')
+ or die "fcntl(F_SETFD, 0) failed:$!";
+ push @sockenv, "$path=" . $sock->fileno;
+ push @sock, $sock;
+ }
$ENV{SERVER_STARTER_PORT} = join ";", @sockenv;
$ENV{SERVER_STARTER_GENERATION} = 0;
@@ -295,9 +322,7 @@ Server::Starter - a superdaemon for hot-deploying server programs
=head1 DESCRIPTION
-It is often a pain to write a server program that supports graceful restarts, with no resource leaks. L<Server::Starter>, solves the problem by splitting the task into two. One is L<start_server>, a script provided as a part of the module, which works as a superdaemon that binds to zero or more TCP ports, and repeatedly spawns the server program that actually handles the necessary tasks (for example, responding to incoming commenctions). The spawned server programs under L<Server::Starter> call accept(2) and handle the requests.
-
-The module can also be used to hot-deploy servers listening to unix domain sockets by omitting the --port option of L<start_server>. In such case, the superdaemon will not bind to any TCP ports but instead concentrate on spawning the server program.
+It is often a pain to write a server program that supports graceful restarts, with no resource leaks. L<Server::Starter>, solves the problem by splitting the task into two. One is L<start_server>, a script provided as a part of the module, which works as a superdaemon that binds to zero or more TCP ports or unix sockets, and repeatedly spawns the server program that actually handles the necessary tasks (for example, responding to incoming commenctions). The spawned server programs under L<Server::Starter> call accept(2) and handle the requests.
To gracefully restart the server program, send SIGHUP to the superdaemon. The superdaemon spawns a new server program, and if (and only if) it starts up successfully, sends SIGTERM to the old server program.
@@ -314,7 +339,7 @@ A Net::Server personality that can be run under L<Server::Starter> exists under
=item server_ports
-Returns zero or more file descriptors on which the server program should call accept(2) in a hashref. Each element of the hashref is: (host:port|port)=file_descriptor.
+Returns zero or more file descriptors on which the server program should call accept(2) in a hashref. Each element of the hashref is: (host:port|port|path_of_unix_socket) => file_descriptor.
=item start_server
@@ -324,8 +349,7 @@ Starts the superdaemon. Used by the C<start_server> scirpt.
=head1 AUTHOR
-Kazuho Oku E<lt>kazuhooku@gmail.comE<gt>
-Copyright (C) 2009-2010 Cybozu Labs, Inc.
+Kazuho Oku
=head1 SEE ALSO
@@ -9,6 +9,7 @@ use Server::Starter qw(start_server restart_server);
my %opts = (
port => [],
+ path => [],
);
GetOptions(
@@ -19,8 +20,8 @@ GetOptions(
$opts{$name} ||= undef;
ref($opts{$name}) ? $opts{$name} : \$opts{$name};
},
- } qw(port=s interval=i log-file=s pid-file=s signal-on-hup=s status-file=s
- restart help version),
+ } qw(port=s path=s interval=i log-file=s pid-file=s signal-on-hup=s
+ status-file=s restart help version),
) or exit 1;
pod2usage(
-exitval => 0,
@@ -68,6 +69,10 @@ This script is a frontend of L<Server::Starter>. For more information please re
TCP port to listen to (if omitted, will not bind to any ports)
+=head2 --path=path
+
+path at where to listen using unix socket (optional)
+
=head2 --interval=seconds
minimum interval to respawn the server program (default: 1)
@@ -98,8 +103,7 @@ prints the version number
=head1 AUTHOR
-Kazuho Oku E<lt>kazuhooku@gmail.comE<gt>
-Copyright (C) 2009 Cybozu Labs, Inc.
+Kazuho Oku
=head1 SEE ALSO
@@ -0,0 +1,22 @@
+#! /usr/bin/perl
+
+use strict;
+use warnings;
+
+use lib qw(blib/lib lib);
+
+use IO::Socket::UNIX;
+use Server::Starter qw(server_ports);
+
+my $listener = IO::Socket::UNIX->new()
+ or die "failed to create unix socket:$!";
+$listener->fdopen((values %{server_ports()})[0], 'w')
+ or die "failde to bind to listening socket:$!";
+
+while (1) {
+ if (my $conn = $listener->accept) {
+ while ($conn->sysread(my $buf, 1048576) > 0) {
+ $conn->syswrite($buf);
+ }
+ }
+}
@@ -0,0 +1,40 @@
+use strict;
+use warnings;
+
+use File::Temp ();
+use IO::Socket::UNIX;
+use Test::More tests => 4;
+use Test::SharedFork;
+
+use Server::Starter qw(start_server);
+
+$SIG{PIPE} = sub {};
+
+my $sockfile = File::Temp::tmpnam();
+
+my $pid = fork;
+die "fork failed: $!"
+ unless defined $pid;
+if ($pid == 0) {
+ # child
+ start_server(
+ path => $sockfile,
+ exec => [ $^X, qw(t/03-starter-unix-echod.pl) ],
+ );
+ exit 0;
+} else {
+ # parent
+ sleep 1
+ until -e $sockfile;
+ my $sock = IO::Socket::UNIX->new(
+ Peer => $sockfile,
+ ) or die "failed to connect to unix socket:$!";
+ is $sock->syswrite('hello', 5), 5, 'write';
+ is $sock->sysread(my $buf, 5), 5, 'read length';
+ is $buf, 'hello', 'read data';
+ kill 'TERM', $pid;
+ while (wait != $pid) {}
+ ok ! -e $sockfile, 'socket file removed after shutdown';
+}
+
+unlink $sockfile;